<!-- HTML header for doxygen 1.9.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CMSIS-Driver: Overview</title>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="tabs.js"></script>
<script type="text/javascript" src="footer.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/javascript" src="darkmode_toggle.js"></script>
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
<link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
<link href="extra_search.css" rel="stylesheet" type="text/css"/>
<link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
<link href="version.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../version.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 55px;">
  <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
   <div id="projectname">CMSIS-Driver
   &#160;<span id="projectnumber"><script type="text/javascript">
     <!--
     writeHeader.call(this);
     writeVersionDropdown.call(this, "CMSIS-Driver");
     //-->
    </script>
   </span>
   </div>
   <div id="projectbrief">Peripheral Interface for Middleware and Application Code</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
  <!--END !PROJECT_NAME-->
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
  <ul class="tablist">
    <script type="text/javascript">
      writeComponentTabs.call(this);
    </script>
  </ul>
</div>
<script type="text/javascript">
  writeSubComponentTabs.call(this);
</script>
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div><div class="header">
  <div class="headertitle"><div class="title">Overview </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="mainpage"></a> <b>CMSIS-Driver</b> specifies generic driver interfaces for peripherals commonly used in embedded systems with Arm® Cortex® processors.</p>
<p>User applications and middleware components can control such peripherals using the <a href="modules.html"><b>CMSIS-Driver API</b></a> and so achieve better code reuse and simpler integration in various ecosystems. The API is designed to be generic and independent of a specific RTOS making it reusable across a wide range of supported microcontroller devices.</p>
<p>The following block diagram shows an exemplary set up for various drivers.</p>
<div class="image">
<img src="driver.png" alt=""/>
<div class="caption">
Example use of CMSIS-Drivers with Middleware</div></div>
    <p>The standard CMSIS-Driver interfaces connect microcontroller peripherals with middleware that implements communication stacks, file system and graphic user interfaces.</p>
<h1><a class="anchor" id="cmsis_drv_benefits"></a>
Benefits</h1>
<p>Using CMSIS-Driver provides great benefits to the embedded developers and software vendors:</p>
<ul>
<li>The CMSIS-Driver API covers <a class="el" href="index.html#cmsis_drv_interfaces">many common peripherals</a> present in modern embedded systems for sensor interaction, data storage, communication and graphics.</li>
<li>The unified API follows the similar design principles across all peripherals. This reduces learning efforts and increases developers' productivity. See <a class="el" href="theoryOperation.html">Theory of Operation</a> for details.</li>
<li>Driver templates files provide code sceletons that help to get started with implementations for specific peripherals. See <a class="el" href="theoryOperation.html#cmsis_driver_files">CMSIS-Driver Files</a>.</li>
<li>Support for multiple driver instances with <a class="el" href="theoryOperation.html#AccessStruct">Access Struct</a>.</li>
<li><a class="el" href="driverValidation.html">Driver-Validation Suite</a> provides a set of tests to verify compatibility to CMSIS-Driver API definitions.</li>
</ul>
<h1><a class="anchor" id="cmsis_drv_interfaces"></a>
Covered Interfaces</h1>
<p>CMSIS-Driver APIs are defined for the following driver interfaces:</p>
<ul>
<li><a class="el" href="group__can__interface__gr.html">CAN</a>: Interface to CAN bus peripheral.</li>
<li><a class="el" href="group__eth__interface__gr.html">Ethernet</a>: Interface to Ethernet MAC and PHY peripheral.</li>
<li><a class="el" href="group__i2c__interface__gr.html">I2C</a>: Multi-master Serial Single-Ended Bus interface driver.</li>
<li><a class="el" href="group__mci__interface__gr.html">MCI</a>: Memory Card Interface for SD/MMC memory.</li>
<li><a class="el" href="group__nand__interface__gr.html">NAND</a>: NAND Flash Memory interface driver.</li>
<li><a class="el" href="group__flash__interface__gr.html">Flash</a>: Flash Memory interface driver.</li>
<li><a class="el" href="group__sai__interface__gr.html">SAI</a>: Serial audio interface driver (I2s, PCM, AC'97, TDM, MSB/LSB Justified).</li>
<li><a class="el" href="group__spi__interface__gr.html">SPI</a>: Serial Peripheral Interface Bus driver.</li>
<li><a class="el" href="group__storage__interface__gr.html">Storage</a>: Storage device interface driver.</li>
<li><a class="el" href="group__usart__interface__gr.html">USART</a>: Universal Synchronous and Asynchronous Receiver/Transmitter interface driver.</li>
<li><a class="el" href="group__usb__interface__gr.html">USB</a>: Interface driver for USB Host and USB Device communication.</li>
<li><a class="el" href="group__gpio__interface__gr.html">GPIO</a>: General-purpose Input/Output driver.</li>
<li><a class="el" href="group__vio__interface__gr.html">VIO</a>: API for virtual I/Os (VIO).</li>
<li><a class="el" href="group__vstream__interface__gr.html">vStream</a>: API for Virtual streaming interface using fixed-size data blocks.</li>
<li><a class="el" href="group__wifi__interface__gr.html">WiFi</a>: Interface driver for wireless communication.</li>
</ul>
<p>A list of current CMSIS-Driver implementations is available <a class="el" href="listOfImplementations.html">here</a>.</p>
<h1><a class="anchor" id="cmsis_driver_pack"></a>
Access to CMSIS-Driver</h1>
<p>CMSIS-Driver intefaces are actively maintained in the <a href="https://github.com/ARM-software/CMSIS_6"><b>CMSIS 6 GitHub repository</b></a> and released as part of the <a href="../General/cmsis_pack.html"><b>CMSIS Software Pack</b></a>.</p>
<p>The CMSIS Software Pack publishes the API Interface under the Component Class <b>CMSIS Driver</b> with header files and a documentation. These header files are the reference for the implementation of the standardized peripheral driver interfaces.</p>
<p>These implementations are published typically in the Device Family Pack of a related microcontroller family under the Component Class <b>CMSIS Driver</b>. A Device Family Pack may contain additional interfaces in the Component Class <b>Device</b> to extend the standard Peripheral Drivers covered by this CMSIS-Driver specification with additional device specific interfaces for example for Memory BUS, GPIO, or DMA.</p>
<p>The following directories and files relevant to CMSIS-Driver are present in the <b>ARM::CMSIS</b> Pack:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Directory   </th><th class="markdownTableHeadLeft">Content    </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">📂 CMSIS   </td><td class="markdownTableBodyLeft">CMSIS Base software components folder    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">┣ 📂 Documentation/html/Driver   </td><td class="markdownTableBodyLeft">A local copy of this CMSIS-Driver documentation    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">┣ 📂 Driver   </td><td class="markdownTableBodyLeft">Directory with CMSIS-Driver component, see <a class="el" href="theoryOperation.html#cmsis_driver_files">CMSIS-Driver Files</a>    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📂 DriverTemplates   </td><td class="markdownTableBodyLeft">Driver Template files (Driver_<em>interface</em>.c)    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📂 Include   </td><td class="markdownTableBodyLeft">API header files (Driver_<em>interface</em>.h, Driver_Common.h)    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">&emsp;&#160; ┗ 📂 VIO   </td><td class="markdownTableBodyLeft">Implementation of virtual Input/Output interface (<a class="el" href="group__vio__interface__gr.html">VIO</a>)   </td></tr>
</table>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">
      <script type="text/javascript">
        <!--
        writeFooter.call(this);
        //-->
      </script> 
    </li>
  </ul>
</div>
</body>
</html>
